home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / ansi15b.lzh / ANSI150B.DOC next >
Encoding:
Text File  |  1992-08-01  |  17.5 KB  |  379 lines

  1.  
  2. ANSITerm                                                 By Timothy Miller
  3. Version 1.5                                            Two Worlds Software                               
  4. Documentation by Timothy Miller & Sean Dougherty
  5.  
  6. (c) Copyright July, 1992 Timothy Miller, Two Worlds Software
  7.  
  8.  NO PORTION OF THIS PROGRAM MAY BE MODIFIED, DISASSEMBLED, DECODED, 
  9.  OR REMOVED BY ANY MEANS WITHOUT PRIOR PERMISSION OF THE AUTHOR.
  10.  NO PORTION OF THIS PROGRAM MAY BE USED IN ANY OTHER PROGRAM. THE
  11.  ABOVE ALSO APPLIES TO THE FONT FILE INCLUDED WITH ANSITERM.
  12.  ALL OTHER RIGHTS RESERVED.
  13.  
  14.  THE USER IS AUTHORIZED TO USE THE PROGRAM ANSITERM, AND HAS
  15.  PERMISSION TO DISTRIBUTE THIS PROGRAM, AT NO COST. NO PROFIT MAY BE
  16.  DERIVED OUT OF THE SALE OF THIS PROGRAM WITHOUT THE SPECIFIC 
  17.  PERMISSION OF THE AUTHOR.  
  18.  
  19.  ** The author can be contacted on Genie (address [T.MILLER23])
  20.  
  21. The following files are part of the ANSITerm package:
  22.    ANSI150B.PRG
  23.    ANSI150B.DOC
  24.    FONT48.DAT
  25. These files MUST be included.  All other files are optional, except 
  26. XYZ which is necessary for file transfers.
  27.  
  28. ANSITerm's Features (* = New features)
  29.  
  30.    - ANSITerm is a 100% ANSI VT-102 compatible terminal program that 
  31.      supports full 16 colors, blinking text, with 80 columns.
  32.    - Supports X-modem, Y-modem, and Z-modem transfers (using XYZ.TTP)
  33.    - Full mouse support and menu bars
  34.    - AutoDialer with separate options (line-feeds, local echo, etc.)
  35.      for every entry.
  36.    * Capture buffer with the ability to send and print selected blocks
  37.    * Selectable color palettes
  38.    * New intelligent memory saving techniques
  39.    * View Buffer and block functions
  40.    * Auto Z-modem Download and Upload
  41.    * Ten 79-character global macros
  42.    * Upload/Download paths can be set along with the path of XYZ.TTP
  43.  
  44. ShareWare Info
  45.  
  46.       This program is shareware and I have put much time into making this
  47.  into the best terminal program possible. If you use and like this program,
  48.  please support the author and allow him to make future upgrades by sending
  49.  a $15 donation or more to:
  50.  
  51.        Timothy Miller
  52.        7519 Winging Way Drive
  53.        Tampa, FL  33615-1519
  54.        U.S.A.
  55.  
  56.        Please make checks payable to Timothy Miller.  All users in the 
  57.        U.S.A. who register will receive free updates by mail.
  58.  
  59.  
  60. File Transfers
  61.  
  62.      File transfers can be accomplished through the use of Alan Hamilton's
  63.    XYZ file transfer program. I have found no way to keep the program
  64.    in memory and call it when needed, so ANSITerm must load it each time
  65.    you transfer a file.  For hard-drive users, this is not a problem 
  66.    since ANSITerm remembers where XYZ is, but for floppy disk users, it
  67.    requires extra effort.  ANSITerm will not allow you to swap floppys 
  68.    (load XYZ from one and transfer to/from another) so the use of a RAM 
  69.    disk is recommended for this purpose.  You can set ANSITerm to load 
  70.    XYZ from the ramdisk.
  71.  
  72. Menu Bars
  73.  
  74.       To select a menu, click on the title.  To make it go away, click
  75.    on the title again, outside of the window or on another title.
  76.  
  77. Auto DIALer Menu
  78.  
  79.        To select a slot that has not been selected, click anywhere on the 
  80.     line except for the field which says DIAL.
  81.  
  82.     To insert a one-second pause in any editing fields sent to the modem, 
  83.     press [F10].  This works for all macros.  To insert a pause into
  84.     the phone number, most modems require a comma.
  85.  
  86.     |DIAL|
  87.       If you click on DIAL on any line which has not been tagged for
  88.       group dial, that slot will immediately be selected, the dialer 
  89.       will go away, and the telephone number listed in that 
  90.       slot will be dialed.  If that slot has been tagged for group
  91.       dial, the dial cycle will begin.
  92.     |J|   (group dial)
  93.       If you click in the small field between DIAL and the name field
  94.       of a selected slot, that field will be tagged for group dial.  If
  95.       you click in that field again, the slot will be untagged.
  96.     |BBS Name       |
  97.       The next field to the right is the name field.  Click here to
  98.       edit.  Left and right arrow keys move the edit cursor left and
  99.       right.  Delete removes the character that the cursor is on and
  100.       moves all characters to the right left to fill in the space.
  101.       Backspace deletes the character to the left of the cursor and
  102.       moves all characters at the right of the cursor to fill in the 
  103.       space.
  104.     |I|
  105.       Initialize string.  This allows a string containing optional
  106.       modem commands to be sent to the modem before the command to
  107.       dial is sent.
  108.     |Phone number|
  109.       To the right is the phone number field.  Click here to edit the
  110.       phone number as you would for the name field.
  111.     | Baud|
  112.       Click here repeatedly until the baud rate you want is displayed.
  113.       The baud rate numbers have been shortened to provide greater space,
  114.       and the numbers are the baud rate divided by one hundred.
  115.     |Options      |
  116.       Each column of this field corresponds directly to an option in the
  117.       options menu, essentially the same order.  They are also listed
  118.       in the help menu.  The meanings of the symbols are listed with
  119.       the OPTN menu information in this manual and below:
  120.          W:  End of line wrap             B:  Destructive back space
  121.          E:  Local Echo                   A:  Application mode
  122.          R:  Cursor Application mode      N:  New line and line feed mode
  123.          G:  IBM Extended Character Graphics Set
  124.          L:  Enable blink
  125.       ZYKXC:  Transfer protocol
  126.              Z:   Z-modem
  127.              Y:   Y-modem (batch)
  128.              K:   X-modem 1k
  129.              X:   X-modem (standard)
  130.              C:   X-modem checksum
  131.          C:  Capture enable               F:  Filter ANSI codes
  132.          Y:  Type-ahead buffer
  133.     | F1: | F2: | F3: |  Macros
  134.       There are 3 44-character macros for each slot in the dial menu.
  135.       To edit one, select a slot, and click on the macro you want to 
  136.       edit.  Edit as you would for the BBS name.  A return character is 
  137.       NOT automatically transmitted at the end of the macro, so you must 
  138.       put one in manually, by pressing the Enter key on the numeric
  139.       keypad.  In fact, any non-printing character (<ESC>, LF, FF, etc.)
  140.       can be entered into the macro editing field and transmitted as part
  141.       of the macro.  To transmit the macro while on-line, press the
  142.       function key corresponding to the macro you wish to send. To send
  143.       a one second pause, press F10 in the editing field where the pause
  144.       is needed.
  145.  
  146. Options (OPTN) Menu
  147.  
  148.     End of line wrap
  149.        With this option off, any character printed at the right most 
  150.        column will overwrite any character at that position without 
  151.        wrapping to the next line.
  152.     Destructive backspace
  153.        When this mode is on, if a backspace character is received,
  154.        the cursor will back up one column and erase any character at
  155.        that position.  If this is not selected, the cursor will back 
  156.        up on column, but not erase any character there.
  157.     Local Echo
  158.         When this option is selected, any keys that you press will be 
  159.         automatically displayed on the screen as well as transmitted. 
  160.         (half duplex mode)
  161.     Application mode
  162.         If this mode is on, the keys on the numeric keypad will send 
  163.         ANSI escape sequences instead of the characters which appear 
  164.         on the keytops.
  165.     Cursor key application mode
  166.         The cursor keys normally send ANSI escape sequences to the
  167.         modem when pressed.  If this option has been selected, a
  168.         different set of escape sequences will be transmitted by
  169.           the same keys.
  170.     New-line and line feed mode
  171.         If this option is selected, linefeed implies both return and 
  172.         linefeed, and the return key sends both return and linefeed.
  173.     IBM Extended Character Graphics Set
  174.         If this mode is on, any characters with a value greater than 
  175.         127 will cause graphics characters to be displayed.  If this 
  176.         mode is off, any such characters will have their most significant 
  177.         bit stripped.  This is for boards and on-line services that 
  178.         insist on using set or even parity.
  179.     Enable blink
  180.         When this is selected, all characters that have been printed 
  181.         with the blink attribute set will flash on and off at regular 
  182.         intervals.
  183.     Dial Command
  184.         When you click on this, you can edit the command that ANSITerm
  185.         sends to the modem to make it dial.  For example, "ATDT" for
  186.         tone dial, "ATDP" for pulse dial, or "ATDT70#," for tone
  187.         dial, call waiting off, and the comma for a pause.
  188.     RTS/CTS
  189.         Enables RTS/CTS hardware flow control. Most ST users require
  190.         a fix program for this to operate properly.         
  191.     Dial timeout
  192.         This allows you to set the number of seconds the cycle dialer
  193.         waits before skipping to the next board selected for group
  194.         dial. Click on this line to edit. If a 0 (zero) is entered,
  195.         NONE is displayed and the cycle dialer will wait until either
  196.         the modem or the user tells it to skip to the next selected
  197.         slot.  
  198.     Edit Macros
  199.         Allows you to edit the 10 global macros.  Shift and a function
  200.         key selects the macro to be edited (RETURN lets you finish 
  201.         editing), and <ESC> lets you exit back to the terminal.  To 
  202.         insert a one-second pause into a macro, press the F10 key.  To 
  203.         transmit a macro, hold the shift key and press a function key.  
  204.         The Alternate-M key combination also starts the macro editor.
  205.     Set Loadup Macro
  206.         When ANSITerm is first booted this macro is sent to the modem,
  207.         unless the DCD (Carrier Detect) line is high. 
  208.     Quit
  209.         Selecting this causes ANSITerm to exit to the program which
  210.         called it (or the GEM Desktop).  This can also be selected by
  211.         pressing the UNDO key.
  212.     o The OPTN menu will not go away if you select one of the options
  213.       so you have the chance to select or deselect more than one option
  214.       before clicking outside of it to remove it from the screen.
  215.  
  216. Select BAUD Menu
  217.  
  218.        You can click in this menu to select your baud rate.  38400 bps 
  219.        is supported, but reliable operation cannot be assumed.
  220.  
  221. FILE Menu
  222.  
  223.    Download
  224.        Loads XYZ from disk (or RAMDISK) to transfer a file.  If 
  225.        Z-modem or Y-modem is selected, transfer will start immediately 
  226.        to the folder you select with the Set D/L Path option.  If
  227.        any other protocol is selected, you will immediately get a
  228.        file selector.  This can also be selected with the Alternate-D
  229.        key combination.
  230.    Upload
  231.        Loads XYZ just as Download, but it always gives you a file 
  232.        selector so that you can select the file to be uploaded (or 
  233.        wildcard for Z-modem or Y-modem).  This can also be selected 
  234.        with the Alternate-U key combination.
  235.    Z-modem, etc.
  236.        Click on one of these to select which protocal you want to use
  237.        at the moment.  As with the OPTN menu, this menu will not go
  238.        away if you select one of the protocols, so you can immediately
  239.        select upload or download without having to reselect the menu.
  240.    Save Dialer/OPTN
  241.        Saves the contents of the DIAL menu, the default download path,
  242.        and the Dial timeout to disk.  If you are using floppy disks
  243.        and running XYZ from a RAMDISK, be sure to save to the floppy disk.
  244.        This also saves the options download/upload path, dial
  245.        timeout, buffer size, delay timing, dial command, buffer
  246.        installed/uninstalled status, color palette number, Loadup Macro,
  247.        baud rate setting, RTS/CTS status, CR/LF filter status, Auto
  248.        Z-modem selected/deselected, and the ten global macros. 
  249.    Load Dialer/OPTN
  250.        Loads a dialer from disk and the options with it.  ANSITerm can
  251.        indirectly support more than one dialer menu and set of options 
  252.        this way.
  253.    Set D/L Path
  254.       This allows you to pre-set the path to which Z-modem and Y-modem
  255.       downloads will be saved.  Clicking here will give you a
  256.       file selector.
  257.    Set U/L Path
  258.       This allows you to pre-set the path to which uploads will be
  259.       directed.  Clicking here will give you a file selector.
  260.    Set XYZ Path
  261.       This is the path of the program, XYZ.TTP, to enable ANSITerm's
  262.       download and upload options.
  263.    Auto Z-modem
  264.       This selection gives ANSITerm the ability to detect Zmodem uploads
  265.       and downloads independant of XYZ. If either an upload string or
  266.       download string is detected, ANSITerm immediately runs XYZ if this
  267.       function is on.
  268.  
  269.  
  270. Capture Buffer (BUFR) menu
  271.  
  272.       If the buffer becomes 75% full, the 'Bufr' menu will change to
  273.    '75%+'.  If, while transmitting the buffer, you suspend sending
  274.    by pressing Alternate-Y, the menu will change to 'Suspnd'.  
  275.  
  276.    Install Buffer
  277.       Allocates the amount of memory specified by the Bufsize editing
  278.       field and makes it available for capturing modem input, screen
  279.       snap-shots, and loading files from disk for transmit or viewing.
  280.    Capture
  281.       When selected, all characters that come from the modem will be
  282.       added to the buffer.
  283.    Filter ANSI
  284.       In this mode, all ANSI escape sequences are filtered out and
  285.       only ASCII text may be added to the buffer.
  286.    Load buffer
  287.       Clears the buffer and loads the specified file into it.
  288.    Save buffer
  289.       Saves the current contents of the buffer to disk.
  290.    Clear buffer
  291.       Empties the buffer.
  292.    Print buffer
  293.       Sends the current contents of the buffer to the printer.
  294.    Send buf
  295.       Sends the current contents of the buffer to the modem and filters
  296.       linefeeds and/or carriage returns according to the setting in
  297.       View Buffer. 
  298.    Bufsize
  299.       You can edit this field if the buffer is NOT installed to 
  300.       change the size of the buffer.  To change the buffer size, 
  301.       you must not have a buffer installed.
  302.    Delay
  303.       This specifies the time (in 1/200 second units) that Send Buf
  304.       (and send block from the buffer viewer) waits between characters 
  305.       while sending data.
  306.    FreeMem
  307.       This is not an option but rather a window that tells you how much 
  308.       free memory you have.
  309.    Used
  310.       This also not selectable, but tells you how many bytes have been 
  311.       added to the buffer.
  312.    Type Ahead
  313.       This activates the type ahead buffer. The buffer can contain up to
  314.       512 ASCII characters and control characters. The Keypad Enter will 
  315.       insert <CR> (and <LF> if NewLine/Line Feed is on), the [HELP] key 
  316.       transmits the buffer contents without a <CR> and the optional <LF>,
  317.       [F10] will insert a one second pause (this also works for the
  318.       various other editing fields that output to the modem), Up arrow
  319.       moves to the beginning, and the down arrow moves to the end.
  320.    View Buffer
  321.       This option switches to the view buffer screen.  ALT-V also 
  322.       activates this.
  323.         Keys: [ESC] - Quits View Buffer mode, 
  324.               [UP/DOWN/LEFT/RIGHT ARROW] - Moves cursor, 
  325.               [U] - Pages Up, and  [D] - Pages Down
  326.            Blocks:   [B]egin   [E]nd   [H]ide   Tran[S]mit   [P]rint
  327.            Filters:  [R]eturn  [L]ine Feed
  328.        INPORTANT: These functions filter Returns and Linefeeds out 
  329.                the selection to transmit in the viewer and ALSO from the 
  330.                complete buffer contents send from the terminal screen.
  331.  
  332. HELP menu
  333.  
  334.       This menu has no selections.  It gives an abridged list of
  335.    the dialer options and short-cut key combinations.
  336.    Special key combinations available:
  337.    F1 to F3     Send macros corresponding to the current dialer slot
  338.                 selections.
  339.    F5           Resets printing colors to white text, black
  340.                 background, no blink, not bold, etc. for all
  341.                 characters received after this is selected, until
  342.                 an ANSI escape sequence is received that changes
  343.                 the colors.
  344.    F6           Prints the contents of the screen to the printer.  If 
  345.                 the printer is off-line, you will hear a bell ring.
  346.                 This does not print a bit-map of the screen, but
  347.                 rather the actual letters.  Bold is emphasized (bold), 
  348.                 and blinking is italicized.  Drop-down menus will not
  349.                 be printed even if they are down when F6 is pressed.
  350.    F7           Capture screen contents to the buffer
  351.    F8 or Alt-H  Causes the modem to drop carrier.
  352.    F10          Inserts a one second pause into an editing field.
  353.    Alt-D        Download               Alt-U        Upload
  354.    Alt-C        Capture                Alt-T        Send Buffer
  355.    Alt-S        Suspend Send           Alt-Y        Type-ahead
  356.    Alt-V        View Buffer            UNDO         Quit ANSITERM
  357.    Alt-M        Edit Global Macros     HELP         (see Type Ahead buffer)
  358.    Clr/Home     Clears the Type-Ahead Buffer
  359.  
  360. COLR menu
  361.    There are 4 selectable color palettes.  Palette #1 is the default,
  362.    unless you save the dialer file while another palette is enabled.
  363.  
  364. Other
  365.  
  366.    A yellow "C" on a red background will appear in the upper right corner 
  367.    if CAPS LOCK is on.
  368.  
  369. Acknowledgments
  370.  
  371.      I would like to thank the following people for testing ANSITerm
  372.    for me:
  373.        Sean Dougherty (another member of Two Worlds Software)
  374.        BJ McKinney (SysOp of The Flea Infested BBS -- (813)989-8564)
  375.        Clifton Mothershed
  376.  
  377.      And we can't forget plaudits to Alan Hamilton for his XYZ file
  378.    transfer utility.
  379.